

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>pyanaconda.ui.lib package &mdash; Anaconda 25.14 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Anaconda 25.14 documentation" href="index.html"/>
        <link rel="up" title="pyanaconda.ui package" href="pyanaconda.ui.html"/>
        <link rel="next" title="pyanaconda.ui.tui package" href="pyanaconda.ui.tui.html"/>
        <link rel="prev" title="pyanaconda.ui.gui.spokes.lib package" href="pyanaconda.ui.gui.spokes.lib.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> Anaconda
          

          
          </a>

          
            
            
              <div class="version">
                25.14
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="release.html">Building a Release</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-options.html">Anaconda Boot Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="kickstart.html">Anaconda Kickstart Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="commit-log.html">Rules for commit messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="driverdisc.html">Brief description of DriverDisc version 3</a></li>
<li class="toctree-l1"><a class="reference internal" href="iscsi.html">iSCSI and Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="multipath.html">Multipath and Anaconda</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">pyanaconda</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="pyanaconda.html">pyanaconda package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="pyanaconda.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.installclasses.html">pyanaconda.installclasses package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.isys.html">pyanaconda.isys package</a></li>
<li class="toctree-l4"><a class="reference internal" href="pyanaconda.packaging.html">pyanaconda.packaging package</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="pyanaconda.ui.html">pyanaconda.ui package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.addons">pyanaconda.addons module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda">pyanaconda.anaconda module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda_argparse">pyanaconda.anaconda_argparse module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.anaconda_log">pyanaconda.anaconda_log module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.bootloader">pyanaconda.bootloader module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.constants">pyanaconda.constants module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.constants_text">pyanaconda.constants_text module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.desktop">pyanaconda.desktop module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.errors">pyanaconda.errors module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.exception">pyanaconda.exception module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.flags">pyanaconda.flags module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.geoloc">pyanaconda.geoloc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.i18n">pyanaconda.i18n module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.ihelp">pyanaconda.ihelp module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.image">pyanaconda.image module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.install">pyanaconda.install module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.installclass">pyanaconda.installclass module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.iutil">pyanaconda.iutil module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.kexec">pyanaconda.kexec module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.keyboard">pyanaconda.keyboard module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.kickstart">pyanaconda.kickstart module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.localization">pyanaconda.localization module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.network">pyanaconda.network module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.nm">pyanaconda.nm module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.ntp">pyanaconda.ntp module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.product">pyanaconda.product module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.progress">pyanaconda.progress module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.pwpolicy">pyanaconda.pwpolicy module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.queuefactory">pyanaconda.queuefactory module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.regexes">pyanaconda.regexes module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.rescue">pyanaconda.rescue module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.safe_dbus">pyanaconda.safe_dbus module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.screensaver">pyanaconda.screensaver module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.simpleconfig">pyanaconda.simpleconfig module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.startup_utils">pyanaconda.startup_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.storage_utils">pyanaconda.storage_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.threads">pyanaconda.threads module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.timezone">pyanaconda.timezone module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.users">pyanaconda.users module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda.vnc">pyanaconda.vnc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyanaconda.html#module-pyanaconda">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests/modules.html">tests</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">Anaconda</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          





<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
          <li><a href="modules.html">pyanaconda</a> &raquo;</li>
      
          <li><a href="pyanaconda.html">pyanaconda package</a> &raquo;</li>
      
          <li><a href="pyanaconda.ui.html">pyanaconda.ui package</a> &raquo;</li>
      
    <li>pyanaconda.ui.lib package</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/pyanaconda.ui.lib.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="pyanaconda-ui-lib-package">
<h1>pyanaconda.ui.lib package<a class="headerlink" href="#pyanaconda-ui-lib-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-pyanaconda.ui.lib.disks">
<span id="pyanaconda-ui-lib-disks-module"></span><h2>pyanaconda.ui.lib.disks module<a class="headerlink" href="#module-pyanaconda.ui.lib.disks" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pyanaconda.ui.lib.disks.FakeDiskLabel">
<em class="property">class </em><code class="descclassname">pyanaconda.ui.lib.disks.</code><code class="descname">FakeDiskLabel</code><span class="sig-paren">(</span><em>free=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.disks.FakeDiskLabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>

<dl class="class">
<dt id="pyanaconda.ui.lib.disks.FakeDisk">
<em class="property">class </em><code class="descclassname">pyanaconda.ui.lib.disks.</code><code class="descname">FakeDisk</code><span class="sig-paren">(</span><em>name</em>, <em>size=0</em>, <em>free=0</em>, <em>partitioned=True</em>, <em>vendor=None</em>, <em>model=None</em>, <em>serial=None</em>, <em>removable=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.disks.FakeDisk" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="pyanaconda.ui.lib.disks.FakeDisk.description">
<code class="descname">description</code><a class="headerlink" href="#pyanaconda.ui.lib.disks.FakeDisk.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="function">
<dt id="pyanaconda.ui.lib.disks.getDisks">
<code class="descclassname">pyanaconda.ui.lib.disks.</code><code class="descname">getDisks</code><span class="sig-paren">(</span><em>devicetree</em>, <em>fake=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.disks.getDisks" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="pyanaconda.ui.lib.disks.isLocalDisk">
<code class="descclassname">pyanaconda.ui.lib.disks.</code><code class="descname">isLocalDisk</code><span class="sig-paren">(</span><em>disk</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.disks.isLocalDisk" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-pyanaconda.ui.lib.entropy">
<span id="pyanaconda-ui-lib-entropy-module"></span><h2>pyanaconda.ui.lib.entropy module<a class="headerlink" href="#module-pyanaconda.ui.lib.entropy" title="Permalink to this headline">¶</a></h2>
<p>Helper module with functions for informing user we are waiting for random
data entropy.</p>
<dl class="function">
<dt id="pyanaconda.ui.lib.entropy.wait_for_entropy">
<code class="descclassname">pyanaconda.ui.lib.entropy.</code><code class="descname">wait_for_entropy</code><span class="sig-paren">(</span><em>msg</em>, <em>desired_entropy</em>, <em>ksdata</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.entropy.wait_for_entropy" title="Permalink to this definition">¶</a></dt>
<dd><p>Show UI dialog/message for waiting for desired random data entropy.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ksdata</strong> (<em>pykickstart.base.BaseHandler</em>) &#8211; kickstart data</li>
<li><strong>desired_entropy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.5)"><em>int</em></a>) &#8211; entropy level to wait for</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">whether to force continuing regardless of the available entropy level</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.5)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="module-pyanaconda.ui.lib.space">
<span id="pyanaconda-ui-lib-space-module"></span><h2>pyanaconda.ui.lib.space module<a class="headerlink" href="#module-pyanaconda.ui.lib.space" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pyanaconda.ui.lib.space.DirInstallSpaceChecker">
<em class="property">class </em><code class="descclassname">pyanaconda.ui.lib.space.</code><code class="descname">DirInstallSpaceChecker</code><span class="sig-paren">(</span><em>storage</em>, <em>payload</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.space.DirInstallSpaceChecker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyanaconda.ui.lib.space.FileSystemSpaceChecker" title="pyanaconda.ui.lib.space.FileSystemSpaceChecker"><code class="xref py py-class docutils literal"><span class="pre">pyanaconda.ui.lib.space.FileSystemSpaceChecker</span></code></a></p>
<p>Use the amount of space available at ROOT_PATH to calculate free space.</p>
<p>This is used for the &#8211;dirinstall option where no storage is mounted and it
is using space from the host&#8217;s filesystem.</p>
<p>Create a new FileSystemSpaceChecker object.</p>
<p>Attributes:</p>
<p>payload  &#8211; An instance of a packaging.Payload subclass.
storage  &#8211; An instance of storage.Storage.</p>
<dl class="method">
<dt id="pyanaconda.ui.lib.space.DirInstallSpaceChecker.check">
<code class="descname">check</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.space.DirInstallSpaceChecker.check" title="Permalink to this definition">¶</a></dt>
<dd><p>Check configured storage against software selections.  When this
method is complete (which should be pretty quickly), the following
attributes are available for inspection:</p>
<dl class="docutils">
<dt>success       &#8211; A simple boolean defining whether there&#8217;s enough</dt>
<dd>space or not.</dd>
<dt>deficit       &#8211; If unsuccessful, how much space the system is</dt>
<dd>short for current software selections.</dd>
<dt>error_message &#8211; If unsuccessful, an error message describing the</dt>
<dd>situation.  This message is suitable for putting
in the info bar at the bottom of a Hub.</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="pyanaconda.ui.lib.space.FileSystemSpaceChecker">
<em class="property">class </em><code class="descclassname">pyanaconda.ui.lib.space.</code><code class="descname">FileSystemSpaceChecker</code><span class="sig-paren">(</span><em>storage</em>, <em>payload</em><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.space.FileSystemSpaceChecker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.5)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>This object provides for a way to verify that enough space is available
on configured file systems to support the current software selections.
It is run as part of completeness checking every time a spoke changes,
therefore moving this step up out of both the storage and software
spokes.</p>
<p>Create a new FileSystemSpaceChecker object.</p>
<p>Attributes:</p>
<p>payload  &#8211; An instance of a packaging.Payload subclass.
storage  &#8211; An instance of storage.Storage.</p>
<dl class="method">
<dt id="pyanaconda.ui.lib.space.FileSystemSpaceChecker.check">
<code class="descname">check</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.space.FileSystemSpaceChecker.check" title="Permalink to this definition">¶</a></dt>
<dd><p>Check configured storage against software selections.  When this
method is complete (which should be pretty quickly), the following
attributes are available for inspection:</p>
<dl class="docutils">
<dt>success       &#8211; A simple boolean defining whether there&#8217;s enough</dt>
<dd>space or not.</dd>
<dt>deficit       &#8211; If unsuccessful, how much space the system is</dt>
<dd>short for current software selections.</dd>
<dt>error_message &#8211; If unsuccessful, an error message describing the</dt>
<dd>situation.  This message is suitable for putting
in the info bar at the bottom of a Hub.</dd>
</dl>
</dd></dl>

<dl class="attribute">
<dt id="pyanaconda.ui.lib.space.FileSystemSpaceChecker.error_template">
<code class="descname">error_template</code><em class="property"> = 'Not enough space in file systems for the current software selection. An additional %s is needed.'</em><a class="headerlink" href="#pyanaconda.ui.lib.space.FileSystemSpaceChecker.error_template" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pyanaconda.ui.lib.space.FileSystemSpaceChecker.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyanaconda.ui.lib.space.FileSystemSpaceChecker.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Get rid of any existing error messages and prepare to run the
check again.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-pyanaconda.ui.lib">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyanaconda.ui.lib" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="pyanaconda.ui.tui.html" class="btn btn-neutral float-right" title="pyanaconda.ui.tui package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="pyanaconda.ui.gui.spokes.lib.html" class="btn btn-neutral" title="pyanaconda.ui.gui.spokes.lib package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2015, Red Hat, Inc..

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'25.14',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>